/*
 * Niiuzu
 * Copyright (C) 2011  Thierry Nowak
 * 
 * This program is free software: you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free Software
 * Foundation, either version 3 of the License, or (at your option) any later
 * version.
 * 
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 * details.
 * 
 * You should have received a copy of the GNU General Public License along with
 * this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package com.niiuzu.client.util.widget;

import com.google.gwt.core.client.GWT;
import com.google.gwt.dom.client.Element;
import com.google.gwt.dom.client.LabelElement;
import com.google.gwt.uibinder.client.UiBinder;
import com.google.gwt.uibinder.client.UiField;
import com.google.gwt.user.client.ui.Composite;
import com.google.gwt.user.client.ui.HasHTML;
import com.google.gwt.user.client.ui.HasText;
import com.google.gwt.user.client.ui.Widget;

/**
 * Widget représentant le libellé placé devant un champ de saisie dans un
 * formulaire.
 */
public class FormLabel extends Composite implements HasHTML, HasText {

	/**
	 * Interface {@link UiBinder} adaptée à la widget {@link FormLabel} .
	 */
	interface SuitedUiBinder extends UiBinder<Widget, FormLabel> {

	}

	private static final String ASTERISK_HTML_VALUE_REQUIRED = "*";
	private static final String ASTERISK_HTML_VALUE_OPTIONAL = "&nbsp;";

	@UiField
	LabelElement labelElement;
	@UiField
	Element asteriskElement;

	/**
	 * Construit une nouvelle instance de {@link FormLabel}.
	 */
	public FormLabel() {
		SuitedUiBinder uiBinder = GWT.create(SuitedUiBinder.class);
		initWidget(uiBinder.createAndBindUi(this));

		asteriskElement.setInnerHTML(ASTERISK_HTML_VALUE_OPTIONAL);
	}

	@Override
	public String getHTML() {
		return labelElement.getInnerHTML();
	}

	@Override
	public void setHTML(String html) {
		labelElement.setInnerHTML(html);
	}

	@Override
	public String getText() {
		return labelElement.getInnerText();
	}

	@Override
	public void setText(String text) {
		labelElement.setInnerText(text);
	}

	/**
	 * Teste si le label indique que le champ associé est un champ obligatoire.
	 * 
	 * @return Par défaut le composant considère que ce champ est facultatif
	 *         (non obligatoire), il retourne <tt>false</tt> dans ce cas.
	 */
	public boolean isRequired() {
		String asteriskHtmlValue = asteriskElement.getInnerHTML();
		return ASTERISK_HTML_VALUE_REQUIRED.equals(asteriskHtmlValue);
	}

	/**
	 * Définit si le champ de saisie associé à ce libellé doit être considéré
	 * comme obligatoire. Une astérisque est affichée à la droite du libellé si
	 * la valeur de <tt>required</tt> est <tt>true</tt>.
	 * 
	 * @param required
	 *            <tt>true</tt> si le champ est considéré comme obligatoire,
	 *            <tt>false</tt> si celui-ci est facultatif.
	 */
	public void setRequired(boolean required) {
		if (required) {
			asteriskElement.setInnerHTML(ASTERISK_HTML_VALUE_REQUIRED);
		} else {
			asteriskElement.setInnerHTML(ASTERISK_HTML_VALUE_OPTIONAL);
		}
	}
}
